home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / FM122.ZIP / FMOVE.DOC < prev    next >
Encoding:
Text File  |  1996-03-09  |  13.6 KB  |  290 lines
  1.         FMove 1.22 - Copyright 1993, 1996, Mike Walker. All rights reserverd.
  2.  
  3.        ┌──────────────────────────────────────────────────────────────────┐
  4.        │▒▒▒▒ Introduction ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  5.        └──────────────────────────────────────────────────────────────────┘
  6.  
  7.         Fmove is a utility used to move or kill files. Files may be killed
  8.         or moved based on number of days old or size. This utility came
  9.         about because I just got tired of looking for such a utility
  10.         myself.
  11.  
  12.        ┌──────────────────────────────────────────────────────────────────┐
  13.        │▒▒▒▒ License and registration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  14.        └──────────────────────────────────────────────────────────────────┘
  15.  
  16.         This program is Shareware. You may use this beta free of charge.
  17.         The license to use this beta version will expire upon the release
  18.         of the next version of Fmove. The release version will be
  19.         distributed as low cost shareware or freeware, I have not decided
  20.         yet. :-)
  21.  
  22.         If the release version of Fmove is released as low cost shareware
  23.         a registration fee will be required for a license to use Fmove.
  24.  
  25.         Either way I am willing to accept any donations in appreciation of
  26.         this work.
  27.  
  28.         You may not charge anything for this program other than a nominal
  29.         fee for the transfer of the program to the transfer media and the
  30.         cost of that media. You may distribute this program freely as long
  31.         as this document and all files contained in the original archive
  32.         remain in thier original state. The author reserves the right to
  33.         change this license argreement.
  34.  
  35.         THE PROGRAM IS PROVIDED "AS-IS". NO WARRANTIES OF ANY KIND, EXPRESS
  36.         OR IMPLIED, ARE MADE AS TO IT OR ANY MEDIUM IT MAY BE ON. NO REMEDY
  37.         IS PROVIDED BY THE AUTHOR FOR INDIRECT, CONSEQUENTIAL, PUNITIVE OR
  38.         INCIDENTAL DAMAGES ARISING FROM IT, INCLUDING SUCH FROM NEGLIGENCE,
  39.         STRICT LIABILITY, OR BREACH OF WARRANTY OR CONTRACT, EVEN AFTER
  40.         NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. USE AT YOUR OWN RISK.
  41.  
  42.        ┌──────────────────────────────────────────────────────────────────┐
  43.        │▒▒▒▒ Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  44.        └──────────────────────────────────────────────────────────────────┘
  45.  
  46.         Extract the archive to your utilities directory, or somewhere
  47.         specifed in the path. Once extracted you will need to create a
  48.         config file, or edit the sample configuration suppied.
  49.         
  50.        ┌──────────────────────────────────────────────────────────────────┐
  51.        │▒▒▒▒ Command Line Options ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  52.        └──────────────────────────────────────────────────────────────────┘
  53.  
  54.         -c Used to specify the config file to use.
  55.         -s Used to specify the schedule to run. (See schedules latter in
  56.            this documentation).
  57.  
  58.         eg. Fmove -csample.cfg -sdostuff
  59.  
  60.        ┌──────────────────────────────────────────────────────────────────┐
  61.        │▒▒▒▒ The Config File ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  62.        └──────────────────────────────────────────────────────────────────┘
  63.  
  64.         The config file can be any name that you choose. When you run the
  65.         program you will need to specify the name on the command line using
  66.         the -c command line switch. If you do not specify a config file
  67.         name an attempt to read the default fmove.cfg will be made. All
  68.         commands within the should all start in the first column of a line.
  69.         Any line starting with a semi-colon will be considered to be a
  70.         comment. Do not place comments at the end of command lines. The
  71.         commands are divided into two groups, global commands and action
  72.         verbs. There is a maximum of 255 action verbs that can be defined
  73.         in the config file. If this is not sufficient then you can use
  74.         multiple config files or schedules. Also keep in mind that the
  75.         action verbs are preformed in the order that they appear in the
  76.         config file. One last note, do not use trailing backslashes for any
  77.         of the paths defined for the action verbs.
  78.  
  79.        ┌──────────────────────────────────────────────────────────────────┐
  80.        │▒▒▒▒ Global Commands ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  81.        └──────────────────────────────────────────────────────────────────┘
  82.  
  83.         UserName
  84.  
  85.                 Syntax: UserName Your_Registered_Name
  86.  
  87.                 If you have a registration key you need to define the name
  88.                 that you used when registering, and use the key that was
  89.                 provided to you with the RegKey command. If you are using
  90.                 an evaluation version or beta of this program do not define
  91.                 a user name.
  92.  
  93.                 Note: Underscores must be used in place of spaces in your
  94.                 name for the UserName command.
  95.  
  96.         ArcFile Syntax: ArcFile FullPath
  97.  
  98.                 The ArcFile command is used for archiving descriptions of
  99.                 killed files. The file name that you use here is appended
  100.                 to when files are killed. Descriptions will also be moved
  101.                 to this file when Remiss is used.
  102.  
  103.         LogFile Syntax: LogFile FullPath
  104.  
  105.                 The Logfile command is used for logging program activity.
  106.                 The log that is created is a binkley style log.
  107.  
  108.         BBS     Syntax: [MAX3]|[FILESBBS]
  109.  
  110.                 Currently there are two possible values for this command.
  111.                 Max3 tells fmove to read maximus file areas by area name.
  112.                 FilesBBS tells fmove to use full path names to the file
  113.                 areas.
  114.  
  115.                 This command ditates how the move and kill commands area
  116.                 used. if the max3 mode is enabled using this command areas
  117.                 will be searched by area name. With max3 mode you will have
  118.                 to replace all paths names with the appropriate area name.
  119.  
  120.         BBSPath Syntax: BBSPath FullPath
  121.  
  122.                 Full path to the BBS system files. Only required for the
  123.                 Max3 support. Do not specify any file names here just the
  124.                 path to the BBS system files eg. D:\MAX
  125.  
  126.         ReIndex Syntax: ReIndex FullPath
  127.  
  128.                 This is the path to your file database build utility.
  129.                 eg. D:\MAX\FB.EXE
  130.  
  131.        ┌──────────────────────────────────────────────────────────────────┐
  132.        │▒▒▒▒ Action Verbs ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  133.        └──────────────────────────────────────────────────────────────────┘
  134.  
  135.         Move    Syntax:
  136.  
  137.                 Move [@]SourcePath TargetPath [-dDays] [-sMaxSize] [-kKeepDays]
  138.  
  139.                 This verb is used to move files from one area to another.
  140.                 The days portion of this command is optional. If you do not
  141.                 specify a number of days with the -d switch the number of
  142.                 days in the global section will be used. If the global
  143.                 command days was not used and the number of days was not
  144.                 specified for the move command, then all files in the
  145.                 source dir will be moved. The number of days for the move
  146.                 command will always take precidence over the global number
  147.                 of days.
  148.  
  149.                 The -sMaxSize switch is used to specify the maximum size of
  150.                 a file in bytes. If a file exceeds maxsize then it will be
  151.                 moved regardless of the number of days specified.
  152.                 
  153.                 The -kKeepDays switch is used to specify the number of days
  154.                 to keep files when they exceed maxsize. Using this switch
  155.                 will cause files that are oversize to be kept for the
  156.                 number of days defined with the keep days switch.
  157.  
  158.                 When moving files the descriptions in files.bbs are moved to
  159.                 the files.bbs at the target path.
  160.  
  161.                 The @ character is used to insert the source path at the
  162.                 beginning of the description in the target files.bbs.
  163.  
  164.         Kill    Syntax: Kill SourcePath [-dDays] [-sMaxSize] [-kKeepDays]
  165.  
  166.                 The kill verb works the same way as the move verb. Except
  167.                 that instead of moving files they are killed. The only
  168.                 difference in syntax is that you do not specify a target
  169.                 path. Be careful with this one, if used incorrectly you
  170.                 could end up killing files that you wanted to keep.
  171.  
  172.                 See documentation on the move command for explanation of
  173.                 the switches.
  174.  
  175.        ┌──────────────────────────────────────────────────────────────────┐
  176.        │▒▒▒▒ Misc Commands ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  177.        └──────────────────────────────────────────────────────────────────┘
  178.  
  179.         All of these commands may be used either as global commands or
  180.         within schedule blocks.
  181.  
  182.         Days    Syntax: Days 30
  183.  
  184.                 This command is used to specify the default number of days
  185.                 used by the action verbs. This command is optional.
  186.  
  187.         KeepOrg Syntax: KeepOrg [Yes|No] (Defaults to no)
  188.  
  189.                 KeepOrg is used to keep the original description when
  190.                 moving or killing files. When this is used the description
  191.                 will not be removed from the source files.bbs file.
  192.  
  193.         Remiss  Syntax: Remiss [Yes|No] (Defaults to no)
  194.  
  195.                 The remiss command is used to check for missing files when
  196.                 moving or killing files. If you use Remiss descriptions
  197.                 will be removed from files.bbs if the associated file is
  198.                 missing from the source directory. If you specify the
  199.                 ArcFile command then the descriptions will be placed in
  200.                 the ArcFile before removing them.
  201.  
  202.         Adopt   Syntax: Adopt [Yes|No] (Defaults to no)
  203.  
  204.                 When the Adopt command is set to no all orphan files will
  205.                 be adopting in the source area before doing any move or
  206.                 kill processing. The files (files.bbs,files.idx,files.dmp
  207.                 files.$$$, and files.bak) are excluded from the adoption
  208.                 process. In case you are wondering the file files.$$$ is
  209.                 Fmove's temporary work file that gets deleted when the
  210.                 program quits.
  211.  
  212.         AdoptDesc Syntax: AdoptDesc 'Description not found'
  213.  
  214.                 The AdoptDesc command is used to define the description
  215.                 to use when adopting orphans. The description can be a
  216.                 maximum of 255 characters in length. If the description
  217.                 contains more than one word then it must be enclosed in
  218.                 quotes.
  219.  
  220.         Exclude Syntax: Exclude Mask
  221.  
  222.                 The Exclude verb is used to exclude files from the move
  223.                 and kill commands. The mask follows the normal dos
  224.                 conventions. For more information on file masks see your
  225.                 dos manual.
  226.  
  227.                 An example of this could be the following:
  228.  
  229.                 Exclude PK*.*
  230.                 Exclude *.SDN
  231.  
  232.                 This would cause Fmove not to move or kill any files that
  233.                 matched the file masks above.
  234.  
  235.        ┌──────────────────────────────────────────────────────────────────┐
  236.        │▒▒▒▒ Schedules ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  237.        └──────────────────────────────────────────────────────────────────┘
  238.  
  239.         Schedules are now supported with Fmove. A schedule is simply a
  240.         series of commands that are executed when the schedule is invoked.
  241.  
  242.         To define a schedule there are two config verbs.
  243.         (Schedule, and EndSchedule).
  244.  
  245.         These two commands work as a pair to name and end schedules. Any
  246.         commands appearing in the config file before the first schedule
  247.         will be considered global commands. Global commands are executed
  248.         for all schedules. To envoke a schedule there is a new command line
  249.         option -s.
  250.  
  251.         When starting Fmove use the command line:
  252.  
  253.         Fmove -cfmove.cfg -sSchedule
  254.  
  255.         Where Schedule is the name of the schedule that you want to run.
  256.  
  257.         Schedule Syntax: Schedule [ScheduleName]
  258.  
  259.                 This command starts the schedule. ScheduleName can be upto
  260.                 32 characters in length. Any commands following the shedule
  261.                 command and before the next 'EndSchedule' will be
  262.                 considered part of that schedule.
  263.  
  264.         EndSchedule Syntax: EndSchedule
  265.  
  266.                 The EndSchedule command does not take any parameters, it
  267.                 simply ends the current schedule.
  268.  
  269.        ┌──────────────────────────────────────────────────────────────────┐
  270.        │▒▒▒▒ How to contact me ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  271.        └──────────────────────────────────────────────────────────────────┘
  272.  
  273.         I can be reached at any of the addresss below. Please report any
  274.         bugs that you find. If I don't know about the problem chances are
  275.         it will not be fixed.
  276.  
  277.          FidoNet: 1:153/809.0
  278.           SigNet: 25:604/400.0
  279.         Internet: mike_walker@mindlink.bc.ca
  280.  
  281.         BBS: Arcadia BBS - 28.8 VFC
  282.               New Westminster, BC
  283.                    Canada
  284.  
  285.                (604) 526-5152
  286.  
  287.  
  288.         Note: If you are calling the BBS using a V.34 modem. My modem does
  289.               have some problems handshaking with certain V.34 modems.
  290.